<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimppainttools: GIMP 3 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP 3 Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manipulating Images and their Properties">
<link rel="prev" href="libgimp3-gimptexttool.html" title="gimptexttool">
<link rel="next" href="GimpVectors.html" title="gimpvectors">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libgimp3-gimppainttools.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimp3-gimptexttool.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GimpVectors.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp3-gimppainttools"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp3-gimppainttools.top_of_page"></a>gimppainttools</span></h2>
<p>gimppainttools — Access to toolbox paint tools.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp3-gimppainttools.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimppainttools.html#gimp-airbrush" title="gimp_airbrush ()">gimp_airbrush</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimppainttools.html#gimp-airbrush-default" title="gimp_airbrush_default ()">gimp_airbrush_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimppainttools.html#gimp-clone" title="gimp_clone ()">gimp_clone</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimppainttools.html#gimp-clone-default" title="gimp_clone_default ()">gimp_clone_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimppainttools.html#gimp-convolve" title="gimp_convolve ()">gimp_convolve</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimppainttools.html#gimp-convolve-default" title="gimp_convolve_default ()">gimp_convolve_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimppainttools.html#gimp-dodgeburn" title="gimp_dodgeburn ()">gimp_dodgeburn</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimppainttools.html#gimp-dodgeburn-default" title="gimp_dodgeburn_default ()">gimp_dodgeburn_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimppainttools.html#gimp-eraser" title="gimp_eraser ()">gimp_eraser</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimppainttools.html#gimp-eraser-default" title="gimp_eraser_default ()">gimp_eraser_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimppainttools.html#gimp-heal" title="gimp_heal ()">gimp_heal</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimppainttools.html#gimp-heal-default" title="gimp_heal_default ()">gimp_heal_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimppainttools.html#gimp-paintbrush" title="gimp_paintbrush ()">gimp_paintbrush</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimppainttools.html#gimp-paintbrush-default" title="gimp_paintbrush_default ()">gimp_paintbrush_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimppainttools.html#gimp-pencil" title="gimp_pencil ()">gimp_pencil</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimppainttools.html#gimp-smudge" title="gimp_smudge ()">gimp_smudge</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimppainttools.html#gimp-smudge-default" title="gimp_smudge_default ()">gimp_smudge_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp3-gimppainttools.description"></a><h2>Description</h2>
<p>Functions giving access to toolbox paint tools.</p>
</div>
<div class="refsect1">
<a name="libgimp3-gimppainttools.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-airbrush"></a><h3>gimp_airbrush ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_airbrush (<em class="parameter"><code><a class="link" href="GimpDrawable.html" title="gimpdrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>,
               <em class="parameter"><code><span class="type">gdouble</span> pressure</code></em>,
               <em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
               <em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Paint in the current brush with varying pressure. Paint application
is time-dependent.</p>
<p>This tool simulates the use of an airbrush. Paint pressure
represents the relative intensity of the paint application. High
pressure results in a thicker layer of paint while low pressure
results in a thinner layer.</p>
<div class="refsect3">
<a name="gimp-airbrush.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pressure</p></td>
<td class="parameter_description"><p>The pressure of the airbrush strokes.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_strokes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-airbrush.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-airbrush-default"></a><h3>gimp_airbrush_default ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_airbrush_default (<em class="parameter"><code><a class="link" href="GimpDrawable.html" title="gimpdrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>,
                       <em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
                       <em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Paint in the current brush with varying pressure. Paint application
is time-dependent.</p>
<p>This tool simulates the use of an airbrush. It is similar to
<a class="link" href="libgimp3-gimppainttools.html#gimp-airbrush" title="gimp_airbrush ()"><code class="function">gimp_airbrush()</code></a> except that the pressure is derived from the
airbrush tools options box. It the option has not been set the
default for the option will be used.</p>
<div class="refsect3">
<a name="gimp-airbrush-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_strokes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-airbrush-default.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-clone"></a><h3>gimp_clone ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_clone (<em class="parameter"><code><a class="link" href="GimpDrawable.html" title="gimpdrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>,
            <em class="parameter"><code><a class="link" href="GimpDrawable.html" title="gimpdrawable"><span class="type">GimpDrawable</span></a> *src_drawable</code></em>,
            <em class="parameter"><code><a href="../html/libgimpbase3-gimpbaseenums.html#GimpCloneType"><span class="type">GimpCloneType</span></a> clone_type</code></em>,
            <em class="parameter"><code><span class="type">gdouble</span> src_x</code></em>,
            <em class="parameter"><code><span class="type">gdouble</span> src_y</code></em>,
            <em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
            <em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Clone from the source to the dest drawable using the current brush</p>
<p>This tool clones (copies) from the source drawable starting at the
specified source coordinates to the dest drawable. If the
\"clone_type\" argument is set to PATTERN-CLONE, then the current
pattern is used as the source and the \"src_drawable\" argument is
ignored. Pattern cloning assumes a tileable pattern and mods the sum
of the src coordinates and subsequent stroke offsets with the width
and height of the pattern. For image cloning, if the sum of the src
coordinates and subsequent stroke offsets exceeds the extents of the
src drawable, then no paint is transferred. The clone tool is
capable of transforming between any image types including
RGB-&gt;Indexed--although converting from any type to indexed is
significantly slower.</p>
<div class="refsect3">
<a name="gimp-clone.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>src_drawable</p></td>
<td class="parameter_description"><p>The source drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>clone_type</p></td>
<td class="parameter_description"><p>The type of clone.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>src_x</p></td>
<td class="parameter_description"><p>The x coordinate in the source image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>src_y</p></td>
<td class="parameter_description"><p>The y coordinate in the source image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_strokes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-clone.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-clone-default"></a><h3>gimp_clone_default ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_clone_default (<em class="parameter"><code><a class="link" href="GimpDrawable.html" title="gimpdrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>,
                    <em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
                    <em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Clone from the source to the dest drawable using the current brush</p>
<p>This tool clones (copies) from the source drawable starting at the
specified source coordinates to the dest drawable. This function
performs exactly the same as the <a class="link" href="libgimp3-gimppainttools.html#gimp-clone" title="gimp_clone ()"><code class="function">gimp_clone()</code></a> function except that
the tools arguments are obtained from the clones option dialog. It
this dialog has not been activated then the dialogs default values
will be used.</p>
<div class="refsect3">
<a name="gimp-clone-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_strokes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-clone-default.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-convolve"></a><h3>gimp_convolve ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_convolve (<em class="parameter"><code><a class="link" href="GimpDrawable.html" title="gimpdrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>,
               <em class="parameter"><code><span class="type">gdouble</span> pressure</code></em>,
               <em class="parameter"><code><a href="../html/libgimpbase3-gimpbaseenums.html#GimpConvolveType"><span class="type">GimpConvolveType</span></a> convolve_type</code></em>,
               <em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
               <em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Convolve (Blur, Sharpen) using the current brush.</p>
<p>This tool convolves the specified drawable with either a sharpening
or blurring kernel. The pressure parameter controls the magnitude of
the operation. Like the paintbrush, this tool linearly interpolates
between the specified stroke coordinates.</p>
<div class="refsect3">
<a name="gimp-convolve.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pressure</p></td>
<td class="parameter_description"><p>The pressure.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>convolve_type</p></td>
<td class="parameter_description"><p>Convolve type.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_strokes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-convolve.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-convolve-default"></a><h3>gimp_convolve_default ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_convolve_default (<em class="parameter"><code><a class="link" href="GimpDrawable.html" title="gimpdrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>,
                       <em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
                       <em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Convolve (Blur, Sharpen) using the current brush.</p>
<p>This tool convolves the specified drawable with either a sharpening
or blurring kernel. This function performs exactly the same as the
<a class="link" href="libgimp3-gimppainttools.html#gimp-convolve" title="gimp_convolve ()"><code class="function">gimp_convolve()</code></a> function except that the tools arguments are
obtained from the convolve option dialog. It this dialog has not
been activated then the dialogs default values will be used.</p>
<div class="refsect3">
<a name="gimp-convolve-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_strokes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-convolve-default.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-dodgeburn"></a><h3>gimp_dodgeburn ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_dodgeburn (<em class="parameter"><code><a class="link" href="GimpDrawable.html" title="gimpdrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>,
                <em class="parameter"><code><span class="type">gdouble</span> exposure</code></em>,
                <em class="parameter"><code><a href="../html/libgimpbase3-gimpbaseenums.html#GimpDodgeBurnType"><span class="type">GimpDodgeBurnType</span></a> dodgeburn_type</code></em>,
                <em class="parameter"><code><a href="../html/libgimpbase3-gimpbaseenums.html#GimpTransferMode"><span class="type">GimpTransferMode</span></a> dodgeburn_mode</code></em>,
                <em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
                <em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Dodgeburn image with varying exposure.</p>
<p>Dodgeburn. More details here later.</p>
<div class="refsect3">
<a name="gimp-dodgeburn.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>exposure</p></td>
<td class="parameter_description"><p>The exposure of the strokes.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dodgeburn_type</p></td>
<td class="parameter_description"><p>The type either dodge or burn.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dodgeburn_mode</p></td>
<td class="parameter_description"><p>The mode.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_strokes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-dodgeburn.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-dodgeburn-default"></a><h3>gimp_dodgeburn_default ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_dodgeburn_default (<em class="parameter"><code><a class="link" href="GimpDrawable.html" title="gimpdrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>,
                        <em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
                        <em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Dodgeburn image with varying exposure. This is the same as the
<a class="link" href="libgimp3-gimppainttools.html#gimp-dodgeburn" title="gimp_dodgeburn ()"><code class="function">gimp_dodgeburn()</code></a> function except that the exposure, type and mode
are taken from the tools option dialog. If the dialog has not been
activated then the defaults as used by the dialog will be used.</p>
<p>Dodgeburn. More details here later.</p>
<div class="refsect3">
<a name="gimp-dodgeburn-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_strokes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-dodgeburn-default.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-eraser"></a><h3>gimp_eraser ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_eraser (<em class="parameter"><code><a class="link" href="GimpDrawable.html" title="gimpdrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>,
             <em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
             <em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>,
             <em class="parameter"><code><a class="link" href="libgimp3-gimpenums.html#GimpBrushApplicationMode" title="enum GimpBrushApplicationMode"><span class="type">GimpBrushApplicationMode</span></a> hardness</code></em>,
             <em class="parameter"><code><a href="../html/libgimpbase3-gimpbaseenums.html#GimpPaintApplicationMode"><span class="type">GimpPaintApplicationMode</span></a> method</code></em>);</pre>
<p>Erase using the current brush.</p>
<p>This tool erases using the current brush mask. If the specified
drawable contains an alpha channel, then the erased pixels will
become transparent. Otherwise, the eraser tool replaces the contents
of the drawable with the background color. Like paintbrush, this
tool linearly interpolates between the specified stroke coordinates.</p>
<div class="refsect3">
<a name="gimp-eraser.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_strokes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>hardness</p></td>
<td class="parameter_description"><p>How to apply the brush.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>method</p></td>
<td class="parameter_description"><p>The paint method to use.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-eraser.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-eraser-default"></a><h3>gimp_eraser_default ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_eraser_default (<em class="parameter"><code><a class="link" href="GimpDrawable.html" title="gimpdrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>,
                     <em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
                     <em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Erase using the current brush.</p>
<p>This tool erases using the current brush mask. This function
performs exactly the same as the <a class="link" href="libgimp3-gimppainttools.html#gimp-eraser" title="gimp_eraser ()"><code class="function">gimp_eraser()</code></a> function except that
the tools arguments are obtained from the eraser option dialog. It
this dialog has not been activated then the dialogs default values
will be used.</p>
<div class="refsect3">
<a name="gimp-eraser-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_strokes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-eraser-default.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-heal"></a><h3>gimp_heal ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_heal (<em class="parameter"><code><a class="link" href="GimpDrawable.html" title="gimpdrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>,
           <em class="parameter"><code><a class="link" href="GimpDrawable.html" title="gimpdrawable"><span class="type">GimpDrawable</span></a> *src_drawable</code></em>,
           <em class="parameter"><code><span class="type">gdouble</span> src_x</code></em>,
           <em class="parameter"><code><span class="type">gdouble</span> src_y</code></em>,
           <em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
           <em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Heal from the source to the dest drawable using the current brush</p>
<p>This tool heals the source drawable starting at the specified source
coordinates to the dest drawable. For image healing, if the sum of
the src coordinates and subsequent stroke offsets exceeds the
extents of the src drawable, then no paint is transferred. The
healing tool is capable of transforming between any image types
except RGB-&gt;Indexed.</p>
<div class="refsect3">
<a name="gimp-heal.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>src_drawable</p></td>
<td class="parameter_description"><p>The source drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>src_x</p></td>
<td class="parameter_description"><p>The x coordinate in the source image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>src_y</p></td>
<td class="parameter_description"><p>The y coordinate in the source image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_strokes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-heal.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-heal-default"></a><h3>gimp_heal_default ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_heal_default (<em class="parameter"><code><a class="link" href="GimpDrawable.html" title="gimpdrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>,
                   <em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
                   <em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Heal from the source to the dest drawable using the current brush</p>
<p>This tool heals from the source drawable starting at the specified
source coordinates to the dest drawable. This function performs
exactly the same as the <a class="link" href="libgimp3-gimppainttools.html#gimp-heal" title="gimp_heal ()"><code class="function">gimp_heal()</code></a> function except that the tools
arguments are obtained from the healing option dialog. It this
dialog has not been activated then the dialogs default values will
be used.</p>
<div class="refsect3">
<a name="gimp-heal-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_strokes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-heal-default.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-paintbrush"></a><h3>gimp_paintbrush ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_paintbrush (<em class="parameter"><code><a class="link" href="GimpDrawable.html" title="gimpdrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>,
                 <em class="parameter"><code><span class="type">gdouble</span> fade_out</code></em>,
                 <em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
                 <em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>,
                 <em class="parameter"><code><a href="../html/libgimpbase3-gimpbaseenums.html#GimpPaintApplicationMode"><span class="type">GimpPaintApplicationMode</span></a> method</code></em>,
                 <em class="parameter"><code><span class="type">gdouble</span> gradient_length</code></em>);</pre>
<p>Paint in the current brush with optional fade out parameter and pull
colors from a gradient.</p>
<p>This tool is the standard paintbrush. It draws linearly interpolated
lines through the specified stroke coordinates. It operates on the
specified drawable in the foreground color with the active brush.
The 'fade-out' parameter is measured in pixels and allows the brush
stroke to linearly fall off. The pressure is set to the maximum at
the beginning of the stroke. As the distance of the stroke nears the
fade-out value, the pressure will approach zero. The gradient-length
is the distance to spread the gradient over. It is measured in
pixels. If the gradient-length is 0, no gradient is used.</p>
<div class="refsect3">
<a name="gimp-paintbrush.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fade_out</p></td>
<td class="parameter_description"><p>Fade out parameter.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_strokes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>method</p></td>
<td class="parameter_description"><p>The paint method to use.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>gradient_length</p></td>
<td class="parameter_description"><p>Length of gradient to draw.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-paintbrush.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-paintbrush-default"></a><h3>gimp_paintbrush_default ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_paintbrush_default (<em class="parameter"><code><a class="link" href="GimpDrawable.html" title="gimpdrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>,
                         <em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
                         <em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Paint in the current brush. The fade out parameter and pull colors
from a gradient parameter are set from the paintbrush options
dialog. If this dialog has not been activated then the dialog
defaults will be used.</p>
<p>This tool is similar to the standard paintbrush. It draws linearly
interpolated lines through the specified stroke coordinates. It
operates on the specified drawable in the foreground color with the
active brush. The 'fade-out' parameter is measured in pixels and
allows the brush stroke to linearly fall off (value obtained from
the option dialog). The pressure is set to the maximum at the
beginning of the stroke. As the distance of the stroke nears the
fade-out value, the pressure will approach zero. The gradient-length
(value obtained from the option dialog) is the distance to spread
the gradient over. It is measured in pixels. If the gradient-length
is 0, no gradient is used.</p>
<div class="refsect3">
<a name="gimp-paintbrush-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_strokes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-paintbrush-default.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pencil"></a><h3>gimp_pencil ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_pencil (<em class="parameter"><code><a class="link" href="GimpDrawable.html" title="gimpdrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>,
             <em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
             <em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Paint in the current brush without sub-pixel sampling.</p>
<p>This tool is the standard pencil. It draws linearly interpolated
lines through the specified stroke coordinates. It operates on the
specified drawable in the foreground color with the active brush.
The brush mask is treated as though it contains only black and white
values. Any value below half is treated as black; any above half, as
white.</p>
<div class="refsect3">
<a name="gimp-pencil.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_strokes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-pencil.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-smudge"></a><h3>gimp_smudge ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_smudge (<em class="parameter"><code><a class="link" href="GimpDrawable.html" title="gimpdrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>,
             <em class="parameter"><code><span class="type">gdouble</span> pressure</code></em>,
             <em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
             <em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Smudge image with varying pressure.</p>
<p>This tool simulates a smudge using the current brush. High pressure
results in a greater smudge of paint while low pressure results in a
lesser smudge.</p>
<div class="refsect3">
<a name="gimp-smudge.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pressure</p></td>
<td class="parameter_description"><p>The pressure of the smudge strokes.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_strokes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-smudge.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-smudge-default"></a><h3>gimp_smudge_default ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_smudge_default (<em class="parameter"><code><a class="link" href="GimpDrawable.html" title="gimpdrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>,
                     <em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
                     <em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Smudge image with varying pressure.</p>
<p>This tool simulates a smudge using the current brush. It behaves
exactly the same as <a class="link" href="libgimp3-gimppainttools.html#gimp-smudge" title="gimp_smudge ()"><code class="function">gimp_smudge()</code></a> except that the pressure value is
taken from the smudge tool options or the options default if the
tools option dialog has not been activated.</p>
<div class="refsect3">
<a name="gimp-smudge-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_strokes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gdouble]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-smudge-default.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>